

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>federatedml.ftl package &mdash; FATE 1.0 documentation</title>
  

  
  
  
  

  
  <script type="text/javascript" src="_static/js/modernizr.min.js"></script>
  
    
      <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
        <script type="text/javascript" src="_static/jquery.js"></script>
        <script type="text/javascript" src="_static/underscore.js"></script>
        <script type="text/javascript" src="_static/doctools.js"></script>
        <script type="text/javascript" src="_static/language_data.js"></script>
    
    <script type="text/javascript" src="_static/js/theme.js"></script>

    

  
  <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" /> 
</head>

<body class="wy-body-for-nav">

   
  <div class="wy-grid-for-nav">
    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >
          

          
            <a href="index.html" class="icon icon-home"> FATE
          

          
          </a>

          
            
            
          

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
            
              
            
            
              <!-- Local TOC -->
              <div class="local-toc"><ul>
<li><a class="reference internal" href="#">federatedml.ftl package</a><ul>
<li><a class="reference internal" href="#subpackages">Subpackages</a></li>
<li><a class="reference internal" href="#submodules">Submodules</a></li>
<li><a class="reference internal" href="#federatedml-ftl-autoencoder-module">federatedml.ftl.autoencoder module</a></li>
<li><a class="reference internal" href="#federatedml-ftl-encrypted-ftl-module">federatedml.ftl.encrypted_ftl module</a></li>
<li><a class="reference internal" href="#federatedml-ftl-faster-encrypted-ftl-module">federatedml.ftl.faster_encrypted_ftl module</a></li>
<li><a class="reference internal" href="#module-federatedml.ftl.plain_ftl">federatedml.ftl.plain_ftl module</a></li>
<li><a class="reference internal" href="#module-federatedml.ftl">Module contents</a></li>
</ul>
</li>
</ul>
</div>
            
          
        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" aria-label="top navigation">
        
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="index.html">FATE</a>
        
      </nav>


      <div class="wy-nav-content">
        
        <div class="rst-content">
        
          















<div role="navigation" aria-label="breadcrumbs navigation">

  <ul class="wy-breadcrumbs">
    
      <li><a href="index.html">Docs</a> &raquo;</li>
        
      <li>federatedml.ftl package</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
            
            <a href="_sources/federatedml.ftl.rst.txt" rel="nofollow"> View page source</a>
          
        
      </li>
    
  </ul>

  
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <div class="section" id="federatedml-ftl-package">
<h1>federatedml.ftl package<a class="headerlink" href="#federatedml-ftl-package" title="Permalink to this headline">¶</a></h1>
<div class="section" id="subpackages">
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="federatedml.ftl.data_util.html">federatedml.ftl.data_util package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="federatedml.ftl.data_util.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="federatedml.ftl.data_util.html#module-federatedml.ftl.data_util.common_data_util">federatedml.ftl.data_util.common_data_util module</a></li>
<li class="toctree-l2"><a class="reference internal" href="federatedml.ftl.data_util.html#module-federatedml.ftl.data_util.log_util">federatedml.ftl.data_util.log_util module</a></li>
<li class="toctree-l2"><a class="reference internal" href="federatedml.ftl.data_util.html#module-federatedml.ftl.data_util.uci_credit_card_util">federatedml.ftl.data_util.uci_credit_card_util module</a></li>
<li class="toctree-l2"><a class="reference internal" href="federatedml.ftl.data_util.html#module-federatedml.ftl.data_util">Module contents</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="federatedml.ftl.eggroll_computation.html">federatedml.ftl.eggroll_computation package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="federatedml.ftl.eggroll_computation.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="federatedml.ftl.eggroll_computation.html#federatedml-ftl-eggroll-computation-helper-module">federatedml.ftl.eggroll_computation.helper module</a></li>
<li class="toctree-l2"><a class="reference internal" href="federatedml.ftl.eggroll_computation.html#federatedml-ftl-eggroll-computation-util-module">federatedml.ftl.eggroll_computation.util module</a></li>
<li class="toctree-l2"><a class="reference internal" href="federatedml.ftl.eggroll_computation.html#module-federatedml.ftl.eggroll_computation">Module contents</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="federatedml.ftl.encryption.html">federatedml.ftl.encryption package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="federatedml.ftl.encryption.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="federatedml.ftl.encryption.html#federatedml-ftl-encryption-encryption-module">federatedml.ftl.encryption.encryption module</a></li>
<li class="toctree-l2"><a class="reference internal" href="federatedml.ftl.encryption.html#module-federatedml.ftl.encryption">Module contents</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="federatedml.ftl.hetero_ftl.html">federatedml.ftl.hetero_ftl package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="federatedml.ftl.hetero_ftl.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="federatedml.ftl.hetero_ftl.html#federatedml-ftl-hetero-ftl-hetero-ftl-arbiter-module">federatedml.ftl.hetero_ftl.hetero_ftl_arbiter module</a></li>
<li class="toctree-l2"><a class="reference internal" href="federatedml.ftl.hetero_ftl.html#module-federatedml.ftl.hetero_ftl.hetero_ftl_base">federatedml.ftl.hetero_ftl.hetero_ftl_base module</a></li>
<li class="toctree-l2"><a class="reference internal" href="federatedml.ftl.hetero_ftl.html#federatedml-ftl-hetero-ftl-hetero-ftl-guest-module">federatedml.ftl.hetero_ftl.hetero_ftl_guest module</a></li>
<li class="toctree-l2"><a class="reference internal" href="federatedml.ftl.hetero_ftl.html#federatedml-ftl-hetero-ftl-hetero-ftl-host-module">federatedml.ftl.hetero_ftl.hetero_ftl_host module</a></li>
<li class="toctree-l2"><a class="reference internal" href="federatedml.ftl.hetero_ftl.html#module-federatedml.ftl.hetero_ftl">Module contents</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="federatedml.ftl.test.html">federatedml.ftl.test package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="federatedml.ftl.test.html#subpackages">Subpackages</a><ul>
<li class="toctree-l3"><a class="reference internal" href="federatedml.ftl.test.functional_test.html">federatedml.ftl.test.functional_test package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="federatedml.ftl.test.functional_test.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="federatedml.ftl.test.functional_test.html#federatedml-ftl-test-functional-test-functional-autoencoder-test-module">federatedml.ftl.test.functional_test.functional_autoencoder_test module</a></li>
<li class="toctree-l4"><a class="reference internal" href="federatedml.ftl.test.functional_test.html#federatedml-ftl-test-functional-test-functional-enc-msg-party-test-module">federatedml.ftl.test.functional_test.functional_enc_msg_party_test module</a></li>
<li class="toctree-l4"><a class="reference internal" href="federatedml.ftl.test.functional_test.html#federatedml-ftl-test-functional-test-functional-faster-enc-msg-party-test-module">federatedml.ftl.test.functional_test.functional_faster_enc_msg_party_test module</a></li>
<li class="toctree-l4"><a class="reference internal" href="federatedml.ftl.test.functional_test.html#module-federatedml.ftl.test.functional_test.functional_load_data_test">federatedml.ftl.test.functional_test.functional_load_data_test module</a></li>
<li class="toctree-l4"><a class="reference internal" href="federatedml.ftl.test.functional_test.html#federatedml-ftl-test-functional-test-functional-plain-msg-party-test-module">federatedml.ftl.test.functional_test.functional_plain_msg_party_test module</a></li>
<li class="toctree-l4"><a class="reference internal" href="federatedml.ftl.test.functional_test.html#federatedml-ftl-test-functional-test-hetero-ftl-plain-guest-test-module">federatedml.ftl.test.functional_test.hetero_ftl_plain_guest_test module</a></li>
<li class="toctree-l4"><a class="reference internal" href="federatedml.ftl.test.functional_test.html#module-federatedml.ftl.test.functional_test">Module contents</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="federatedml.ftl.test.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="federatedml.ftl.test.html#module-federatedml.ftl.test.common_data_util_test">federatedml.ftl.test.common_data_util_test module</a></li>
<li class="toctree-l2"><a class="reference internal" href="federatedml.ftl.test.html#federatedml-ftl-test-eggroll-xy-test-module">federatedml.ftl.test.eggroll_XY_test module</a></li>
<li class="toctree-l2"><a class="reference internal" href="federatedml.ftl.test.html#federatedml-ftl-test-eggroll-x-plus-y-test-module">federatedml.ftl.test.eggroll_X_plus_Y_test module</a></li>
<li class="toctree-l2"><a class="reference internal" href="federatedml.ftl.test.html#federatedml-ftl-test-eggroll-encryption-matmul-test-module">federatedml.ftl.test.eggroll_encryption_matmul_test module</a></li>
<li class="toctree-l2"><a class="reference internal" href="federatedml.ftl.test.html#federatedml-ftl-test-eggroll-encryption-runtime-test-module">federatedml.ftl.test.eggroll_encryption_runtime_test module</a></li>
<li class="toctree-l2"><a class="reference internal" href="federatedml.ftl.test.html#federatedml-ftl-test-eggroll-encryption-test-module">federatedml.ftl.test.eggroll_encryption_test module</a></li>
<li class="toctree-l2"><a class="reference internal" href="federatedml.ftl.test.html#module-federatedml.ftl.test.eggroll_storage_test">federatedml.ftl.test.eggroll_storage_test module</a></li>
<li class="toctree-l2"><a class="reference internal" href="federatedml.ftl.test.html#federatedml-ftl-test-host-guest-factory-test-module">federatedml.ftl.test.host_guest_factory_test module</a></li>
<li class="toctree-l2"><a class="reference internal" href="federatedml.ftl.test.html#module-federatedml.ftl.test.mock_models">federatedml.ftl.test.mock_models module</a></li>
<li class="toctree-l2"><a class="reference internal" href="federatedml.ftl.test.html#federatedml-ftl-test-params-validation-test-module">federatedml.ftl.test.params_validation_test module</a></li>
<li class="toctree-l2"><a class="reference internal" href="federatedml.ftl.test.html#federatedml-ftl-test-random-mask-test-module">federatedml.ftl.test.random_mask_test module</a></li>
<li class="toctree-l2"><a class="reference internal" href="federatedml.ftl.test.html#module-federatedml.ftl.test.util">federatedml.ftl.test.util module</a></li>
<li class="toctree-l2"><a class="reference internal" href="federatedml.ftl.test.html#federatedml-ftl-test-whitebox-autoencoder-test-module">federatedml.ftl.test.whitebox_autoencoder_test module</a></li>
<li class="toctree-l2"><a class="reference internal" href="federatedml.ftl.test.html#federatedml-ftl-test-whitebox-enc-gradients-test-module">federatedml.ftl.test.whitebox_enc_gradients_test module</a></li>
<li class="toctree-l2"><a class="reference internal" href="federatedml.ftl.test.html#federatedml-ftl-test-whitebox-faster-enc-gradients-test-module">federatedml.ftl.test.whitebox_faster_enc_gradients_test module</a></li>
<li class="toctree-l2"><a class="reference internal" href="federatedml.ftl.test.html#federatedml-ftl-test-whitebox-plain-gradients-test-module">federatedml.ftl.test.whitebox_plain_gradients_test module</a></li>
<li class="toctree-l2"><a class="reference internal" href="federatedml.ftl.test.html#module-federatedml.ftl.test">Module contents</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
</div>
<div class="section" id="federatedml-ftl-autoencoder-module">
<h2>federatedml.ftl.autoencoder module<a class="headerlink" href="#federatedml-ftl-autoencoder-module" title="Permalink to this headline">¶</a></h2>
</div>
<div class="section" id="federatedml-ftl-encrypted-ftl-module">
<h2>federatedml.ftl.encrypted_ftl module<a class="headerlink" href="#federatedml-ftl-encrypted-ftl-module" title="Permalink to this headline">¶</a></h2>
</div>
<div class="section" id="federatedml-ftl-faster-encrypted-ftl-module">
<h2>federatedml.ftl.faster_encrypted_ftl module<a class="headerlink" href="#federatedml-ftl-faster-encrypted-ftl-module" title="Permalink to this headline">¶</a></h2>
</div>
<div class="section" id="module-federatedml.ftl.plain_ftl">
<span id="federatedml-ftl-plain-ftl-module"></span><h2>federatedml.ftl.plain_ftl module<a class="headerlink" href="#module-federatedml.ftl.plain_ftl" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="federatedml.ftl.plain_ftl.LocalPlainFederatedTransferLearning">
<em class="property">class </em><code class="descclassname">federatedml.ftl.plain_ftl.</code><code class="descname">LocalPlainFederatedTransferLearning</code><span class="sig-paren">(</span><em>guest: federatedml.ftl.plain_ftl.PlainFTLGuestModel</em>, <em>host: federatedml.ftl.plain_ftl.PlainFTLHostModel</em>, <em>private_key=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/federatedml/ftl/plain_ftl.html#LocalPlainFederatedTransferLearning"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.ftl.plain_ftl.LocalPlainFederatedTransferLearning" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<dl class="method">
<dt id="federatedml.ftl.plain_ftl.LocalPlainFederatedTransferLearning.fit">
<code class="descname">fit</code><span class="sig-paren">(</span><em>X_A</em>, <em>X_B</em>, <em>y</em>, <em>overlap_indexes</em>, <em>non_overlap_indexes</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/federatedml/ftl/plain_ftl.html#LocalPlainFederatedTransferLearning.fit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.ftl.plain_ftl.LocalPlainFederatedTransferLearning.fit" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="federatedml.ftl.plain_ftl.LocalPlainFederatedTransferLearning.predict">
<code class="descname">predict</code><span class="sig-paren">(</span><em>X_B</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/federatedml/ftl/plain_ftl.html#LocalPlainFederatedTransferLearning.predict"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.ftl.plain_ftl.LocalPlainFederatedTransferLearning.predict" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="class">
<dt id="federatedml.ftl.plain_ftl.PartyModelInterface">
<em class="property">class </em><code class="descclassname">federatedml.ftl.plain_ftl.</code><code class="descname">PartyModelInterface</code><a class="reference internal" href="_modules/federatedml/ftl/plain_ftl.html#PartyModelInterface"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.ftl.plain_ftl.PartyModelInterface" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<dl class="method">
<dt id="federatedml.ftl.plain_ftl.PartyModelInterface.predict">
<code class="descname">predict</code><span class="sig-paren">(</span><em>X</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/federatedml/ftl/plain_ftl.html#PartyModelInterface.predict"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.ftl.plain_ftl.PartyModelInterface.predict" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="federatedml.ftl.plain_ftl.PartyModelInterface.receive_components">
<code class="descname">receive_components</code><span class="sig-paren">(</span><em>components</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/federatedml/ftl/plain_ftl.html#PartyModelInterface.receive_components"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.ftl.plain_ftl.PartyModelInterface.receive_components" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="federatedml.ftl.plain_ftl.PartyModelInterface.receive_gradients">
<code class="descname">receive_gradients</code><span class="sig-paren">(</span><em>gradients</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/federatedml/ftl/plain_ftl.html#PartyModelInterface.receive_gradients"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.ftl.plain_ftl.PartyModelInterface.receive_gradients" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="federatedml.ftl.plain_ftl.PartyModelInterface.send_components">
<code class="descname">send_components</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/federatedml/ftl/plain_ftl.html#PartyModelInterface.send_components"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.ftl.plain_ftl.PartyModelInterface.send_components" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="federatedml.ftl.plain_ftl.PartyModelInterface.send_gradients">
<code class="descname">send_gradients</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/federatedml/ftl/plain_ftl.html#PartyModelInterface.send_gradients"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.ftl.plain_ftl.PartyModelInterface.send_gradients" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="class">
<dt id="federatedml.ftl.plain_ftl.PlainFTLGuestModel">
<em class="property">class </em><code class="descclassname">federatedml.ftl.plain_ftl.</code><code class="descname">PlainFTLGuestModel</code><span class="sig-paren">(</span><em>local_model</em>, <em>model_param</em>, <em>is_trace=False</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/federatedml/ftl/plain_ftl.html#PlainFTLGuestModel"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.ftl.plain_ftl.PlainFTLGuestModel" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#federatedml.ftl.plain_ftl.PartyModelInterface" title="federatedml.ftl.plain_ftl.PartyModelInterface"><code class="xref py py-class docutils literal notranslate"><span class="pre">federatedml.ftl.plain_ftl.PartyModelInterface</span></code></a></p>
<dl class="method">
<dt id="federatedml.ftl.plain_ftl.PlainFTLGuestModel.get_loss_grads">
<code class="descname">get_loss_grads</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/federatedml/ftl/plain_ftl.html#PlainFTLGuestModel.get_loss_grads"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.ftl.plain_ftl.PlainFTLGuestModel.get_loss_grads" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="federatedml.ftl.plain_ftl.PlainFTLGuestModel.get_model_parameters">
<code class="descname">get_model_parameters</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/federatedml/ftl/plain_ftl.html#PlainFTLGuestModel.get_model_parameters"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.ftl.plain_ftl.PlainFTLGuestModel.get_model_parameters" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="federatedml.ftl.plain_ftl.PlainFTLGuestModel.predict">
<code class="descname">predict</code><span class="sig-paren">(</span><em>uB</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/federatedml/ftl/plain_ftl.html#PlainFTLGuestModel.predict"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.ftl.plain_ftl.PlainFTLGuestModel.predict" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="federatedml.ftl.plain_ftl.PlainFTLGuestModel.receive_components">
<code class="descname">receive_components</code><span class="sig-paren">(</span><em>components</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/federatedml/ftl/plain_ftl.html#PlainFTLGuestModel.receive_components"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.ftl.plain_ftl.PlainFTLGuestModel.receive_components" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="federatedml.ftl.plain_ftl.PlainFTLGuestModel.receive_loss">
<code class="descname">receive_loss</code><span class="sig-paren">(</span><em>loss</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/federatedml/ftl/plain_ftl.html#PlainFTLGuestModel.receive_loss"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.ftl.plain_ftl.PlainFTLGuestModel.receive_loss" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="federatedml.ftl.plain_ftl.PlainFTLGuestModel.restore_model">
<code class="descname">restore_model</code><span class="sig-paren">(</span><em>model_parameters</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/federatedml/ftl/plain_ftl.html#PlainFTLGuestModel.restore_model"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.ftl.plain_ftl.PlainFTLGuestModel.restore_model" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="federatedml.ftl.plain_ftl.PlainFTLGuestModel.send_components">
<code class="descname">send_components</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/federatedml/ftl/plain_ftl.html#PlainFTLGuestModel.send_components"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.ftl.plain_ftl.PlainFTLGuestModel.send_components" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="federatedml.ftl.plain_ftl.PlainFTLGuestModel.send_loss">
<code class="descname">send_loss</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/federatedml/ftl/plain_ftl.html#PlainFTLGuestModel.send_loss"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.ftl.plain_ftl.PlainFTLGuestModel.send_loss" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="federatedml.ftl.plain_ftl.PlainFTLGuestModel.set_batch">
<code class="descname">set_batch</code><span class="sig-paren">(</span><em>X</em>, <em>y</em>, <em>non_overlap_indexes=None</em>, <em>overlap_indexes=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/federatedml/ftl/plain_ftl.html#PlainFTLGuestModel.set_batch"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.ftl.plain_ftl.PlainFTLGuestModel.set_batch" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="class">
<dt id="federatedml.ftl.plain_ftl.PlainFTLHostModel">
<em class="property">class </em><code class="descclassname">federatedml.ftl.plain_ftl.</code><code class="descname">PlainFTLHostModel</code><span class="sig-paren">(</span><em>local_model</em>, <em>model_param</em>, <em>is_trace=False</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/federatedml/ftl/plain_ftl.html#PlainFTLHostModel"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.ftl.plain_ftl.PlainFTLHostModel" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#federatedml.ftl.plain_ftl.PartyModelInterface" title="federatedml.ftl.plain_ftl.PartyModelInterface"><code class="xref py py-class docutils literal notranslate"><span class="pre">federatedml.ftl.plain_ftl.PartyModelInterface</span></code></a></p>
<dl class="method">
<dt id="federatedml.ftl.plain_ftl.PlainFTLHostModel.get_loss_grads">
<code class="descname">get_loss_grads</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/federatedml/ftl/plain_ftl.html#PlainFTLHostModel.get_loss_grads"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.ftl.plain_ftl.PlainFTLHostModel.get_loss_grads" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="federatedml.ftl.plain_ftl.PlainFTLHostModel.get_model_parameters">
<code class="descname">get_model_parameters</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/federatedml/ftl/plain_ftl.html#PlainFTLHostModel.get_model_parameters"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.ftl.plain_ftl.PlainFTLHostModel.get_model_parameters" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="federatedml.ftl.plain_ftl.PlainFTLHostModel.predict">
<code class="descname">predict</code><span class="sig-paren">(</span><em>X</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/federatedml/ftl/plain_ftl.html#PlainFTLHostModel.predict"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.ftl.plain_ftl.PlainFTLHostModel.predict" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="federatedml.ftl.plain_ftl.PlainFTLHostModel.receive_components">
<code class="descname">receive_components</code><span class="sig-paren">(</span><em>components</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/federatedml/ftl/plain_ftl.html#PlainFTLHostModel.receive_components"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.ftl.plain_ftl.PlainFTLHostModel.receive_components" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="federatedml.ftl.plain_ftl.PlainFTLHostModel.restore_model">
<code class="descname">restore_model</code><span class="sig-paren">(</span><em>model_parameters</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/federatedml/ftl/plain_ftl.html#PlainFTLHostModel.restore_model"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.ftl.plain_ftl.PlainFTLHostModel.restore_model" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="federatedml.ftl.plain_ftl.PlainFTLHostModel.send_components">
<code class="descname">send_components</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/federatedml/ftl/plain_ftl.html#PlainFTLHostModel.send_components"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.ftl.plain_ftl.PlainFTLHostModel.send_components" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="federatedml.ftl.plain_ftl.PlainFTLHostModel.set_batch">
<code class="descname">set_batch</code><span class="sig-paren">(</span><em>X</em>, <em>overlap_indexes</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/federatedml/ftl/plain_ftl.html#PlainFTLHostModel.set_batch"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.ftl.plain_ftl.PlainFTLHostModel.set_batch" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="function">
<dt id="federatedml.ftl.plain_ftl.sigmoid">
<code class="descclassname">federatedml.ftl.plain_ftl.</code><code class="descname">sigmoid</code><span class="sig-paren">(</span><em>x</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/federatedml/ftl/plain_ftl.html#sigmoid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.ftl.plain_ftl.sigmoid" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</div>
<div class="section" id="module-federatedml.ftl">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-federatedml.ftl" title="Permalink to this headline">¶</a></h2>
</div>
</div>


           </div>
           
          </div>
          <footer>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2019, FATE_TEAM

    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>

        </div>
      </div>

    </section>

  </div>
  


  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script>

  
  
    
   

</body>
</html>